Hide the versioned struct fields from the public API #4248
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ersioned structs from the public API. Signed-off-by: Stukalov-A-M <[email protected]>
…ersioned structs from the public API. Signed-off-by: Stukalov-A-M <[email protected]>
…ersioned structs from the public API. Signed-off-by: Stukalov-A-M <[email protected]>
…ersioned structs from the public API. Signed-off-by: Stukalov-A-M <[email protected]>
Stukalov-A-M
requested review from
s8sato,
mversic,
Arjentix,
SamHSmith,
QuentinI,
outoftardis,
ilchu,
pesterev,
Erigara,
0x009922 and
DCNick3
as code owners
github-actions
bot
added
the
iroha2-dev
mversic
reviewed
Jan 31, 2024
| @@ -589,7 +589,7 @@ impl Client { | |||
| transaction: &SignedTransaction, | |||
| ) -> Result<HashOf<TransactionPayload>> { | |||
| let (init_sender, init_receiver) = tokio::sync::oneshot::channel(); | |||
| let hash = transaction.payload().hash(); | |||
| let hash = transaction.transaction().payload.hash(); | |||
There was a problem hiding this comment.
Suggested change
| let hash = transaction.transaction().payload.hash(); | |
| let hash = transaction.hash(); |
should be like this
Comment on lines
+262
to
268
| /// Define the version of SignedTransaction | ||
| /// Created to provide access to the transaction payload only to internal libs | ||
| // TODO: Make a correct implementation | ||
| pub fn transaction(&self) -> &SignedTransactionV1 { | ||
| let SignedTransaction::V1(tx) = self; | ||
| &tx.payload | ||
| tx | ||
| } |
There was a problem hiding this comment.
remove this function or make it private or guard it with transparent_api macro. Client must not get a handle to SignedTransactionV1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Payload is hidden by transparent API
(method transaction() returns a SignedTransactionV1 struct, which fields are hidden by transparent API)
Linked issue
Benefits
Checklist
CONTRIBUTING.md